/*
 * Copyright (c) 2013   Tobias Welther
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package de.tudarmstadt.kom.androidsensorapi.sensor.data.concrete;

import android.hardware.Sensor;
import android.hardware.SensorEvent;

import java.util.Date;

import de.tudarmstadt.kom.androidsensorapi.sensor.data.AbstractSensorData;

/**
 * Created by Tobias Welther
 */
public class GyroscopeSensorData extends AbstractSensorData{

    /**
     * This is the rate of rotation around the X axis.
     * The value is in rad/s.
     */
    private final float rateOfRotationX;

    /**
     * This is the rate of rotation around the Y axis.
     * The value is in rad/s.
     */
    private final float rateOfRotationY;

    /**
     * This is the rate of rotation around the Z axis.
     * The value is in rad/s.
     */
    private final float rateOfRotationZ;


    /**
     * Creates Gyroscope Data with the rotation speeds on all axis.
     *
     * @param dateOfCreation the event occurred.
     * @param rateOfRotationX the rotation speed on the X axis.
     * @param rateOfRotationY the rotation speed on the Y axis.
     * @param rateOfRotationZ the rotation speed on the Z axis.
     */
    public GyroscopeSensorData(Date dateOfCreation, float rateOfRotationX, float rateOfRotationY, float rateOfRotationZ) {
        super(dateOfCreation);

        this.rateOfRotationX = rateOfRotationX;
        this.rateOfRotationY = rateOfRotationY;
        this.rateOfRotationZ = rateOfRotationZ;
    }


    /**
     * Generates Gyroscope Data from a given SensorEvent.
     * It is assumed that the Event is of type: SensorInterface.TYPE_GYROSCOPE.
     *
     * This can throw an unsupported Operation Exception when the wrong or insufficient Data is passed.
     *
     * @param event to copy from
     *
     * @throws UnsupportedOperationException when wrong event is passed.
     */
    public GyroscopeSensorData(SensorEvent event) {
        super(event);

        if(event.sensor.getType() != Sensor.TYPE_GYROSCOPE ||
                event.values.length < 3){

            throw new UnsupportedOperationException("The Gyroscope Data can not be read from: "
                    + event.sensor.getName());
        }

        float[] values = event.values;
        this.rateOfRotationX = values[0];
        this.rateOfRotationY = values[1];
        this.rateOfRotationZ = values[2];
    }


    /**
     * This is the rate of rotation around the X axis.
     * The value is in rad/s.
     *
     * @return the rotation speed on X axis.
     */
    public float getRateOfRotationX() {
        return rateOfRotationX;
    }


    /**
     * This is the rate of rotation around the Y axis.
     * The value is in rad/s.
     *
     * @return the rotation speed on Y axis.
     */
    public float getRateOfRotationY() {
        return rateOfRotationY;
    }


    /**
     * This is the rate of rotation around the Z axis.
     * The value is in rad/s.
     *
     * @return the rotation speed on Z axis.
     */
    public float getRateOfRotationZ() {
        return rateOfRotationZ;
    }
}
